Python Add the Amazon Neptune Python follow #7473

scmacdon · 2025-06-05T14:58:32Z

This pull request adds the Amazon Neptune Python follow

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

rlhagerm

Once you've made the high-level fixes and it matches the specification, I can do a full review.

.doc_gen/metadata/neptune_metadata.yaml

python/example_code/neptune/HelloNeptune.py

python/example_code/neptune/NeptuneScenario.py

python/example_code/neptune/tests/test_neptune_scenario_integration.py

rlhagerm · 2025-06-11T15:30:28Z

python/example_code/neptune/tests/test_neptune_test.py

+@pytest.fixture(scope="module")
+def neptune_client():
+    """Create a real Neptune boto3 client for integration testing."""
+    client = boto3.client("neptune", region_name="us-east-1")


Let's follow the current testing patterns in the library until we decide as a team to change it.

Modelled tests after the Keyspace. Confirmed we follow pattern too

scmacdon · 2025-06-13T17:01:35Z

The Hello and Scenario examples run as excepted. The tests have been refactored to follow other Python tests such as Keyspace. The Spec was updated to include SME contributed code examples.

rlhagerm · 2025-06-16T18:54:28Z

python/example_code/neptune/neptune_scenario.py

+        print(f"Deleting DB Cluster: {cluster_id}")
+        neptune_client.delete_db_cluster(**request)
+    except ClientError as e:
+        raise


Where is the exception handling for the ResourceNotFoundException?

rlhagerm · 2025-06-16T18:56:28Z

python/example_code/neptune/neptune_scenario.py

+    try:
+        db_cluster_id = create_db_cluster(neptune_client, cluster_name)
+    except ClientError as ce:
+        code = ce.response["Error"]["Code"]


The exception handling should be in the function, not in the scenario, so that it is visible within the code snippet. Same for all handling, it should follow the pattern of being in the function with the client call.

For all Java sceanrio developed - the service method throws back the exception to the calling code where its handles and displayed. I assumed it was a better way for Python. Checked with Bedrock that relied:

" This is a good practice to handle the exceptions in the calling code, instead of displaying the exception in the service method. Here's why:

By handling the exceptions in the calling code, you're keeping the responsibility of the service method focused on its primary task, which is to delete the DB instance. The calling code is then responsible for handling the various exceptions that may arise, making the code more modular and easier to maintain."

rlhagerm · 2025-06-16T20:26:54Z

python/example_code/neptune/analytics/create_neptune_graph_example.py

+    Main entry point: create NeptuneGraph client and call graph creation.
+    """
+    # Hypothetical client - boto3 currently doesn't have NeptuneGraph client, so replace with actual client if available
+    neptune_graph_client = boto3.client("neptune")


Hypothetical client? This seems incorrect, either there is a client for this code or there isn't. The code below seems to correctly create a neptune-graph client, so why is this one hypothetical?

rlhagerm · 2025-06-16T20:34:02Z

python/example_code/neptune/analytics/create_neptune_graph_example.py

+    try:
+        print("Creating Neptune graph...")
+
+        # Hypothetical method for create_graph, adjust accordingly if you use HTTP API or SDK extensions


Why is the method hypothetical?

rlhagerm · 2025-06-16T20:38:01Z

python/example_code/neptune/analytics/neptune_analytics_query_example.py

+
+    try:
+        response = client.execute_query(
+            GraphIdentifier=graph_id,


The capitalization in the parameters of all of these methods does not match the documentation and it also does not match the code provided by the SME:

`resp =client.execute_query( graphIdentifier = graph_id, queryString="MATCH (n {code: 'ANC'}) RETURN n", language='OPEN_CYPHER' ) print(resp['payload'].read().decode('UTF-8')`

Please recheck that the parameters match exactly on all these graph and data examples.

rlhagerm · 2025-06-16T20:45:28Z

python/example_code/neptune/tests/test_neptune_scenario_integration.py

+
+# Import your scenario file; ensure Python can locate it.
+# If your file is named `neptune_scenario.py`, this import will work:
+import NeptuneScenario


I'm not able to run any of the tests that use the scenario file, I get an error: ModuleNotFoundError: No module named 'NeptuneScenario'

I am seeing all tests pass

================================================ 22 passed in 30.77s ====

rlhagerm · 2025-06-16T20:47:00Z

python/example_code/neptune/tests/test_start_db_cluster.py

+    # --- Success case ---
+    mock_neptune = MagicMock()
+    paginator_mock = MagicMock()
+    mock_neptune.get_paginator.return_value = paginator_mock


We want to use the established stubber pattern for the client responses, see the files in the test_tools directory, and add a file such as neptune_stubber.py for each client to stub the responses.

This did nto work from that folder. Only way it worked was to get it into local folder. No idea why.

rlhagerm · 2025-06-16T20:47:32Z

scenarios/basics/neptune/SPECIFICATION.md


+As there is limited room in aboce table, the metadata key for `executeOpenCypherExplainQuery`is neptune_ExecuteOpenCypherExplainQuery.


I think this can go back into the table, it seems to look fine there and will be harder to find here.

rlhagerm · 2025-06-18T15:09:27Z

python/example_code/neptune/analytics/create_neptune_graph_example.py

+            graph_name=graph_name
+        )
+
+        created_graph_name = response.get("GraphName")


Is GraphName even in the response? I don't see it: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/neptune-graph/client/create_graph.html

And the other properties appear to be incorrectly named or capitalized as well.

Fixed - sure make it harder to verify without running code in IDE

rlhagerm · 2025-06-18T20:35:49Z

python/example_code/neptune/analytics/neptune_analytics_query_example.py

+        print(resp['payload'].read().decode('UTF-8'))
+
+    except client.exceptions.InternalServerException as e:
+        print(f"InternalServerException: {e.response['Error']['Message']}")


The code looks for exceptions that don't exist for that client. For example, LimitExceededException is not in this list: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/services/neptune-graph.html#client-exceptions

rlhagerm · 2025-06-18T20:36:23Z

python/example_code/neptune/analytics/create_neptune_graph_example.py

+def execute_create_graph(client, graph_name):
+    try:
+        print("Creating Neptune graph...")
+        response = client.create_graph(graph_name=graph_name)


This code has an incorrect parameter and is missing a required parameter also.

add python neptune follow

cfffdd3

scmacdon self-assigned this Jun 5, 2025

scmacdon added Python This issue relates to the AWS SDK for Python (boto3) Basics A basic code example showing the core actions for a particular service. labels Jun 5, 2025

scmacdon added 10 commits June 5, 2025 13:35

added Hello Neptune

67b8e9e

added Hello Neptune

2c28b21

added data Neptune examples

1003c0e

added data Neptune examples

9d8fbae

added python to SOS

9602110

added python to SOS

61d4de2

added python to SOS

281c96d

added python to SOS

194a234

added Readme

97bd8b8

added Readme

43f9145

scmacdon added the Follow After Scouts, more languages are added to examples as Follows. label Jun 6, 2025

scmacdon requested a review from beqqrry-aws June 6, 2025 19:59

beqqrry-aws approved these changes Jun 10, 2025

View reviewed changes

Merge branch 'main' into neptunepy

3c971ff

scmacdon added the On Call Review needed This work needs an on-call review label Jun 10, 2025

rlhagerm requested changes Jun 11, 2025

View reviewed changes

rolled in review comments

d2e8089

rlhagerm removed the On Call Review needed This work needs an on-call review label Jun 12, 2025

scmacdon added 2 commits June 12, 2025 14:40

rolled in review comments

2b3de9e

rolled in review comments

a8c9e2d

scmacdon added 2 commits June 13, 2025 13:02

rolled in review comments

049ae7b

rolled in review comments

0e6e9dd

rlhagerm requested changes Jun 16, 2025

View reviewed changes

scmacdon added 2 commits June 17, 2025 16:00

rolled in reivew comments

c20c387

rolled in reivew comments

0281100

rolled in more comments

178b6f3

rlhagerm reviewed Jun 18, 2025

View reviewed changes

scmacdon added 3 commits June 18, 2025 11:36

fixed tag

9143afb

more review comments

4a1711d

more review comments

0b63a09

rlhagerm reviewed Jun 18, 2025

View reviewed changes

more review comments

73b0a1b


		As there is limited room in aboce table, the metadata key for `executeOpenCypherExplainQuery`is neptune_ExecuteOpenCypherExplainQuery.

Python Add the Amazon Neptune Python follow #7473

Are you sure you want to change the base?

Python Add the Amazon Neptune Python follow #7473

Uh oh!

Conversation

scmacdon commented Jun 5, 2025

Uh oh!

rlhagerm left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

scmacdon commented Jun 13, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

scmacdon Jun 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rlhagerm Jun 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

scmacdon Jun 17, 2025 •

edited

Loading

rlhagerm Jun 18, 2025 •

edited

Loading